/*
CpGears v1.0

Copyright (c) 2010 Yves Riel http://www.flash-factor.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package cpgears.movie.widget {
	import cpgears.movie.container.ContainerType;
	import flash.events.IEventDispatcher;
	

	/**
	* Dispatched when the widget visibility has changed.
	*
	* @eventType cpgears.movie.widget.events.VISIBILITY_CHANGED
	*/
	[Event(name = "visibilityChanged", type = "cpgears.movie.widget.events.WidgetVisibilityEvent")]
	
	/**
	 * Information about the Widget in the Captivate movie context.
	 * 
	 * @author Whyves
	 */
	public interface IWidget extends IEventDispatcher {

		/**
		 * The container type in which the widget is embedded.
		 */
		function get containerType():ContainerType
		
		/**
		 * Returns if the widget is currently enabled in the Captivate movie.
		 */
		function isWidgetEnabled():Boolean;

		/**
		 * Returns if the widget is currently visible in the Captivate movie.
		 * 
		 * <P>A widget is considered as enabled when it is present on the slide or on the Timeline.</P>
		 */
		function isWidgetVisible():Boolean;
		
		/**
		 * The widget's width
		 */
		function get width():Number;
		
		/**
		 * The widget's height
		 */
		function get height():Number;
		
		/**
		 * Resets Captivate's scaling.
		 */
		function resetScaling():void;
	}
}